Class DHCPClientProcessImpl

All Implemented Interfaces:
IPCObject, DHCPClientProcess, Process

public class DHCPClientProcessImpl extends ProcessImpl implements DHCPClientProcess
Information provided by the PKI file:

    \class DhcpClientProcess
    
    \brief DhcpClientProcess handles the DHCP client process.
    
    \example network().getDevice("Router0").getProcess("DhcpClient")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • removePortDataEntry

      public void removePortDataEntry(String portName)
      Information provided by the PKI file:
      
          \brief Runs DHCP on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
              
      Specified by:
      removePortDataEntry in interface DHCPClientProcess
      Parameters:
      portName - Takes in a parameter of portName
    • addPortDataEntry

      public void addPortDataEntry(String portName)
      Specified by:
      addPortDataEntry in interface DHCPClientProcess
      Parameters:
      portName - Takes in a parameter of portName
    • isPortExisted

      public boolean isPortExisted(String portName)
      Information provided by the PKI file:
      
          \brief Runs DHCP on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      isPortExisted in interface DHCPClientProcess
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • dhcpRun

      public void dhcpRun(String portName)
      Information provided by the PKI file:
      
          \brief Start dhcp process on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
              
      Specified by:
      dhcpRun in interface DHCPClientProcess
      Parameters:
      portName - Takes in a parameter of portName
    • dhcpRelease

      public boolean dhcpRelease(String portName)
      Information provided by the PKI file:
      
          \brief Releases the DHCP lease from the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      dhcpRelease in interface DHCPClientProcess
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • resetDhcpConfOn

      public boolean resetDhcpConfOn(String portName)
      Information provided by the PKI file:
      
          \brief Resets the DHCP configuration on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      resetDhcpConfOn in interface DHCPClientProcess
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • getDataOfPort

      public DHCPClientPortData getDataOfPort(String portName)
      Specified by:
      getDataOfPort in interface DHCPClientProcess
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      DHCPClientPortData Returns a DHCPClientPortData